Skip to content

Support custom cover heights #3779

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 5 commits into from
Nov 5, 2025
Merged

Support custom cover heights #3779

merged 5 commits into from
Nov 5, 2025

Conversation

@viktorrenkema
Copy link
Contributor

@viktorrenkema viktorrenkema commented Oct 31, 2025 •
edited
Loading

This PR handles the GBO-side of enabling cover height resizing. The basic idea is:

  1. by default, we handle cover images the same as usual (aka there's a fixed aspect ratio as recommended in the docs that we adhere to, so this can lead to cover images of e.g. < 100px tall on smaller viewports)
  2. if height exists on the page cover, it means the cover was resized. because we can't/shouldnt enforce an aspect ratio on a cover that has a dynamic height, different logic kicks in to determine the appropriate height depending on the dimensions so that the entire image is contained within the cover

The previous PR was reverted, as we didn't do step 1 above: we applied the 'new' sizing rules to existing page covers, which causes a lot of existing page covers to regress.

To help explain how a page cover has a fixed aspect ratio by default but how setting a height will impact that, we have tooltip UI in the editor + I have a CR ready to add more details in the support article.

CleanShot.2025-11-03.at.15.21.03.mp4

@changeset-bot
Copy link

changeset-bot bot commented Oct 31, 2025 •
edited
Loading

⚠️ No Changeset found

Latest commit: 3e31638

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions
Copy link
Contributor

github-actions bot commented Oct 31, 2025 •
edited
Loading

Summary of the deployments:

Version URL Status
Vercel https://gitbook-v2-hxa0n9y0h-gitbook.vercel.app ✅
Cloudflare https://607708f7-gitbook-open-v2-preview.gitbook.workers.dev ✅

Test content

Site 2v 2c
GitBook https://gitbook-v2-hxa0n9y0h-gitbook.vercel.app/url/gitbook.com/docs https://607708f7-gitbook-open-v2-preview.gitbook.workers.dev/url/gitbook.com/docs
E2E https://gitbook-v2-hxa0n9y0h-gitbook.vercel.app/url/gitbook.gitbook.io/test-gitbook-open https://607708f7-gitbook-open-v2-preview.gitbook.workers.dev/url/gitbook.gitbook.io/test-gitbook-open

@argos-ci
Copy link

argos-ci bot commented Oct 31, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build Status Details Updated (UTC)
customers-v2 (Inspect) 👍 Changes approved 1 changed, 4 added Nov 5, 2025, 1:09 PM
v2-cloudflare (Inspect) 👍 Changes approved 1 changed Nov 5, 2025, 1:12 PM
v2-vercel (Inspect) 👍 Changes approved 2 changed Nov 5, 2025, 1:12 PM

@viktorrenkema viktorrenkema force-pushed the viktor/support-custom-cover-heights branch from a207335 to 45e5c86 Compare October 31, 2025 19:28
@viktorrenkema viktorrenkema force-pushed the viktor/support-custom-cover-heights branch from 45e5c86 to 9cfddb9 Compare October 31, 2025 19:35
@viktorrenkema viktorrenkema force-pushed the viktor/support-custom-cover-heights branch from 9cfddb9 to 9cd0359 Compare October 31, 2025 19:46
@viktorrenkema viktorrenkema marked this pull request as ready for review November 3, 2025 14:23
conico974
conico974 reviewed Nov 3, 2025
View reviewed changes
Copy link
Contributor

@conico974 conico974 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't it an issue that both light and dark image use the same sizes/aspect-ratio/position ?

@viktorrenkema
Copy link
Contributor Author

viktorrenkema commented Nov 3, 2025

Isn't it an issue that both light and dark image use the same sizes/aspect-ratio/position ?

Yeah it is, I listed the same as a current limitation somewhere in another PR. I chatted about it with samy but while it'd be nice to support heights and object fit on both dark and light mode individually, its just not included yet in this feature release.

@viktorrenkema viktorrenkema force-pushed the viktor/support-custom-cover-heights branch from cc4de25 to 4ed4d44 Compare November 5, 2025 12:57
conico974
conico974 approved these changes Nov 5, 2025
View reviewed changes
@viktorrenkema viktorrenkema force-pushed the viktor/support-custom-cover-heights branch from 4ed4d44 to 3e31638 Compare November 5, 2025 13:02
@viktorrenkema viktorrenkema merged commit 35dcaca into main Nov 5, 2025
19 of 20 checks passed
@viktorrenkema viktorrenkema deleted the viktor/support-custom-cover-heights branch November 5, 2025 13:21
clairechabas added a commit that referenced this pull request Nov 10, 2025
@clairechabas
Merge branch 'main' into claire/RND-8419-support-new-sidebartitle-pag…
8fe0be2 
…e-option

* main: (48 commits)
  Edgeless Assistant window on `depth: flat` sites (#3788)
  Add heredoc support for cURL JSON body (#3790)
  Update site layout and blocks with container queries (#3780)
  Rework OpenAPI Authorizations + scopes (#3786)
  Support custom cover heights (#3779)
  Update `DropdownMenu` styling (#3787)
  Treat pages without visible TOC items as `no-toc` (#3783)
  Implement unique title tags for sections & variants (#3768)
  Add page breadcrumbs to search results (#3784)
  Expand code block when printing (#3782)
  Disable Workers Observability (#3781)
  Reword "Everywhere" search scope to "All docs" (#3776)
  Add padding to TOC page group items (#3777)
  Improve OAuth2 scopes handling in OpenAPI (#3775)
  Support translations and generic variants together (#3772)
  Initialize hash on mount and improve navigation handling (#3774)
  Revert "Support cover image heights and positioning changes" (#3771)
  Fix search container shadow (#3770)
  Redirect to space base path on fallback true (#3745)
  Add isRoot prop to PagesList for root header offset (#3759)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@conico974 conico974 conico974 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@viktorrenkema @conico974